'\" te
.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH GSS_TEST_OID_SET_MEMBER 3GSS "Jan 15, 2003"
.SH NAME
gss_test_oid_set_member \- interrogate an object identifier set
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ]
#include <gssapi/gssapi.h>

\fBOM_uint32\fR \fBgss_test_oid_set_member\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
     \fBconst gss_OID\fR \fImember\fR,\fBconst gss_OID_set\fR \fIset\fR,
     \fBint *\fR\fIpresent\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBgss_test_oid_set_member()\fR function interrogates an object identifier
set to determine if a specified object identifier is a member.  This function
should be used with \fBOID\fR sets returned by \fBgss_indicate_mechs\fR(3GSS),
\fBgss_acquire_cred\fR(3GSS), and \fBgss_inquire_cred\fR(3GSS), but it will
also work with user-generated sets.
.SH PARAMETERS
.sp
.LP
The parameter descriptions for \fBgss_test_oid_set_member()\fR follow:
.sp
.ne 2
.na
\fB\fIminor_status\fR\fR
.ad
.RS 16n
A mechanism-specific status code
.RE

.sp
.ne 2
.na
\fB\fImember\fR\fR
.ad
.RS 16n
An object identifier whose presence is to be tested
.RE

.sp
.ne 2
.na
\fB\fIset\fR\fR
.ad
.RS 16n
An object identifier set.
.RE

.sp
.ne 2
.na
\fB\fIpresent\fR\fR
.ad
.RS 16n
The value of \fIpresent\fR is non-zero if the specified \fBOID\fR is a member
of the set; if not, the value of \fIpresent\fR is zero.
.RE

.SH ERRORS
.sp
.LP
The \fBgss_test_oid_set_member()\fR function may return the following status
codes:
.sp
.ne 2
.na
\fB\fBGSS_S_COMPLETE\fR\fR
.ad
.RS 18n
Successful completion
.RE

.sp
.ne 2
.na
\fB\fBGSS_S_FAILURE\fR\fR
.ad
.RS 18n
The underlying mechanism detected an error for which no specific \fBGSS\fR
status code is defined.  The mechanism-specific status code reported by means
of the \fIminor_status\fR parameter details the error condition.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7)  for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
MT-Level	Safe
.TE

.SH SEE ALSO
.sp
.LP
.BR gss_acquire_cred (3GSS),
.BR gss_indicate_mechs (3GSS),
.BR gss_inquire_cred (3GSS),
.BR attributes (7)
.sp
.LP
\fISolaris Security for Developers Guide\fR
